Skip to content

[EXAMPLE-DO-NOT-MERGE] Update FCL JS documentation from fcl-js@3fe593e5 #1305

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from

Conversation

mfbz
Copy link
Contributor

@mfbz mfbz commented Jun 3, 2025

This PR updates the FCL JS documentation from the latest release in the fcl-js repo.

Documentation automatically generated by the fcl-js docs-generator workflow.

Copy link

vercel bot commented Jun 3, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 3, 2025 5:49pm

description: FCL packages documentation.
---

> _Doc autogenerated from [onflow/fcl-js](https://github.com/onflow/fcl-js)_
Copy link
Contributor

@briandoyle81 briandoyle81 Jun 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we please update this message to have a comment explicitly say not to edit it:

<!-- THIS DOCUMENT IS AUTO-GENERATED. DO NOT EDIT MANUALLY -->

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, adding exactly that line.

Comment on lines +20 to +21
### `address`
- Type: `string`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It probably doesn't matter with how the site is rendered, but if possible, please add a blank line between all headings/subheadings and content

@@ -0,0 +1,47 @@
---
sidebar_position: 1
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There should be a title in the frontmatter. This is what will be rendered in the sidebar and at the top of the page, unless you do a H1 like you have here.


## Returns

`InteractionBuilderFn`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we link to what this is?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Links are added only to types that belong to typedefs package that are considered "core types". This one is a type local to the package and so its type definition is added completely in the lines below to have an easy and fast to use reference

@mfbz
Copy link
Contributor Author

mfbz commented Jun 3, 2025

All comments feedbacks implemented, thanks @briandoyle81!

@mfbz mfbz closed this Jun 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants